Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Introduce readme element to Kraftfile #1286

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from

Conversation

nderjung
Copy link
Member

@nderjung nderjung commented Feb 21, 2024

Prerequisite checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Ran make fmt on your commit series before opening this PR;
  • Updated relevant documentation.

Description of changes

This PR introduces the ability to specify either a string or path to a README text file in a Kraftfile. At the same time, this is propagated to the OCI index as an annotation. In the OCI annotation, the string contents is base64 encoded.

Example usage

  1. As a short-form string:
    spec: v0.6
    readme: "This unikernel is amazing"
  2. As a long-form string:
    spec: v0.6
    readme: |
      This unikernel is amazing!
  3. As an external file:
    spec: v0.6
    readme: ./README.md

TODO

This PR is still in draft form, the following additional pieces of work need to occur:

  • Propagate the package's readme into kraft pkg info

@nderjung nderjung force-pushed the nderjung/feat/kraftfile-extra-metadata branch 4 times, most recently from 9a39700 to 3aa0e1a Compare February 21, 2024 13:58
Signed-off-by: Alexander Jung <[email protected]>
Simultaneously propagate this information to the OCI manifest.

Signed-off-by: Alexander Jung <[email protected]>
@nderjung nderjung force-pushed the nderjung/feat/kraftfile-extra-metadata branch from 3aa0e1a to 65c6605 Compare February 21, 2024 14:32
@nderjung nderjung marked this pull request as ready for review April 10, 2024 10:35
@craciunoiuc
Copy link
Member

@nderjung how's this going?

@nderjung nderjung marked this pull request as draft April 11, 2024 07:12
@nderjung
Copy link
Member Author

Not sure why it was converted out of draft state. There's still an outstanding TODO w.r.t. getting back this information, such that it appears in kraft pkg info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🧊 Icebox
Development

Successfully merging this pull request may close these issues.

2 participants